<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *     http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>    package org.apache.commons.configuration;<a name="line.18"></a>
<FONT color="green">019</FONT>    <a name="line.19"></a>
<FONT color="green">020</FONT>    import org.apache.commons.configuration.HierarchicalConfiguration.Node;<a name="line.20"></a>
<FONT color="green">021</FONT>    import org.apache.commons.configuration.tree.ConfigurationNode;<a name="line.21"></a>
<FONT color="green">022</FONT>    import org.xml.sax.Attributes;<a name="line.22"></a>
<FONT color="green">023</FONT>    import org.xml.sax.helpers.AttributesImpl;<a name="line.23"></a>
<FONT color="green">024</FONT>    <a name="line.24"></a>
<FONT color="green">025</FONT>    /**<a name="line.25"></a>
<FONT color="green">026</FONT>     * &lt;p&gt;A specialized SAX2 XML parser that "parses" hierarchical<a name="line.26"></a>
<FONT color="green">027</FONT>     * configuration objects.&lt;/p&gt;<a name="line.27"></a>
<FONT color="green">028</FONT>     * &lt;p&gt;This class mimics to be a SAX conform XML parser. Instead of parsing<a name="line.28"></a>
<FONT color="green">029</FONT>     * XML documents it processes a {@code Configuration} object and<a name="line.29"></a>
<FONT color="green">030</FONT>     * generates SAX events for the single properties defined there. This enables<a name="line.30"></a>
<FONT color="green">031</FONT>     * the whole world of XML processing for configuration objects.&lt;/p&gt;<a name="line.31"></a>
<FONT color="green">032</FONT>     * &lt;p&gt;The {@code HierarchicalConfiguration} object to be parsed can be<a name="line.32"></a>
<FONT color="green">033</FONT>     * specified using a constructor or the {@code setConfiguration()} method.<a name="line.33"></a>
<FONT color="green">034</FONT>     * This object will be processed by the {@code parse()} methods. Note<a name="line.34"></a>
<FONT color="green">035</FONT>     * that these methods ignore their argument.&lt;/p&gt;<a name="line.35"></a>
<FONT color="green">036</FONT>     *<a name="line.36"></a>
<FONT color="green">037</FONT>     * @author &lt;a<a name="line.37"></a>
<FONT color="green">038</FONT>     * href="http://commons.apache.org/configuration/team-list.html"&gt;Commons Configuration team&lt;/a&gt;<a name="line.38"></a>
<FONT color="green">039</FONT>     * @version $Id: HierarchicalConfigurationXMLReader.java 1209998 2011-12-03 20:31:16Z oheger $<a name="line.39"></a>
<FONT color="green">040</FONT>     */<a name="line.40"></a>
<FONT color="green">041</FONT>    public class HierarchicalConfigurationXMLReader extends ConfigurationXMLReader<a name="line.41"></a>
<FONT color="green">042</FONT>    {<a name="line.42"></a>
<FONT color="green">043</FONT>        /** Stores the configuration object to be parsed.*/<a name="line.43"></a>
<FONT color="green">044</FONT>        private HierarchicalConfiguration configuration;<a name="line.44"></a>
<FONT color="green">045</FONT>    <a name="line.45"></a>
<FONT color="green">046</FONT>        /**<a name="line.46"></a>
<FONT color="green">047</FONT>         * Creates a new instance of {@code HierarchicalConfigurationXMLReader}.<a name="line.47"></a>
<FONT color="green">048</FONT>         */<a name="line.48"></a>
<FONT color="green">049</FONT>        public HierarchicalConfigurationXMLReader()<a name="line.49"></a>
<FONT color="green">050</FONT>        {<a name="line.50"></a>
<FONT color="green">051</FONT>            super();<a name="line.51"></a>
<FONT color="green">052</FONT>        }<a name="line.52"></a>
<FONT color="green">053</FONT>    <a name="line.53"></a>
<FONT color="green">054</FONT>        /**<a name="line.54"></a>
<FONT color="green">055</FONT>         * Creates a new instance of {@code HierarchicalConfigurationXMLReader} and<a name="line.55"></a>
<FONT color="green">056</FONT>         * sets the configuration to be parsed.<a name="line.56"></a>
<FONT color="green">057</FONT>         *<a name="line.57"></a>
<FONT color="green">058</FONT>         * @param config the configuration object<a name="line.58"></a>
<FONT color="green">059</FONT>         */<a name="line.59"></a>
<FONT color="green">060</FONT>        public HierarchicalConfigurationXMLReader(HierarchicalConfiguration config)<a name="line.60"></a>
<FONT color="green">061</FONT>        {<a name="line.61"></a>
<FONT color="green">062</FONT>            this();<a name="line.62"></a>
<FONT color="green">063</FONT>            setConfiguration(config);<a name="line.63"></a>
<FONT color="green">064</FONT>        }<a name="line.64"></a>
<FONT color="green">065</FONT>    <a name="line.65"></a>
<FONT color="green">066</FONT>        /**<a name="line.66"></a>
<FONT color="green">067</FONT>         * Returns the configuration object to be parsed.<a name="line.67"></a>
<FONT color="green">068</FONT>         *<a name="line.68"></a>
<FONT color="green">069</FONT>         * @return the configuration object to be parsed<a name="line.69"></a>
<FONT color="green">070</FONT>         */<a name="line.70"></a>
<FONT color="green">071</FONT>        public HierarchicalConfiguration getConfiguration()<a name="line.71"></a>
<FONT color="green">072</FONT>        {<a name="line.72"></a>
<FONT color="green">073</FONT>            return configuration;<a name="line.73"></a>
<FONT color="green">074</FONT>        }<a name="line.74"></a>
<FONT color="green">075</FONT>    <a name="line.75"></a>
<FONT color="green">076</FONT>        /**<a name="line.76"></a>
<FONT color="green">077</FONT>         * Sets the configuration object to be parsed.<a name="line.77"></a>
<FONT color="green">078</FONT>         *<a name="line.78"></a>
<FONT color="green">079</FONT>         * @param config the configuration object to be parsed<a name="line.79"></a>
<FONT color="green">080</FONT>         */<a name="line.80"></a>
<FONT color="green">081</FONT>        public void setConfiguration(HierarchicalConfiguration config)<a name="line.81"></a>
<FONT color="green">082</FONT>        {<a name="line.82"></a>
<FONT color="green">083</FONT>            configuration = config;<a name="line.83"></a>
<FONT color="green">084</FONT>        }<a name="line.84"></a>
<FONT color="green">085</FONT>    <a name="line.85"></a>
<FONT color="green">086</FONT>        /**<a name="line.86"></a>
<FONT color="green">087</FONT>         * Returns the configuration object to be processed.<a name="line.87"></a>
<FONT color="green">088</FONT>         *<a name="line.88"></a>
<FONT color="green">089</FONT>         * @return the actual configuration object<a name="line.89"></a>
<FONT color="green">090</FONT>         */<a name="line.90"></a>
<FONT color="green">091</FONT>        @Override<a name="line.91"></a>
<FONT color="green">092</FONT>        public Configuration getParsedConfiguration()<a name="line.92"></a>
<FONT color="green">093</FONT>        {<a name="line.93"></a>
<FONT color="green">094</FONT>            return getConfiguration();<a name="line.94"></a>
<FONT color="green">095</FONT>        }<a name="line.95"></a>
<FONT color="green">096</FONT>    <a name="line.96"></a>
<FONT color="green">097</FONT>        /**<a name="line.97"></a>
<FONT color="green">098</FONT>         * Processes the actual configuration object to generate SAX parsing events.<a name="line.98"></a>
<FONT color="green">099</FONT>         */<a name="line.99"></a>
<FONT color="green">100</FONT>        @Override<a name="line.100"></a>
<FONT color="green">101</FONT>        protected void processKeys()<a name="line.101"></a>
<FONT color="green">102</FONT>        {<a name="line.102"></a>
<FONT color="green">103</FONT>            getConfiguration().getRoot().visit(new SAXVisitor(), null);<a name="line.103"></a>
<FONT color="green">104</FONT>        }<a name="line.104"></a>
<FONT color="green">105</FONT>    <a name="line.105"></a>
<FONT color="green">106</FONT>        /**<a name="line.106"></a>
<FONT color="green">107</FONT>         * A specialized visitor class for generating SAX events for a<a name="line.107"></a>
<FONT color="green">108</FONT>         * hierarchical node structure.<a name="line.108"></a>
<FONT color="green">109</FONT>         *<a name="line.109"></a>
<FONT color="green">110</FONT>         */<a name="line.110"></a>
<FONT color="green">111</FONT>        class SAXVisitor extends HierarchicalConfiguration.NodeVisitor<a name="line.111"></a>
<FONT color="green">112</FONT>        {<a name="line.112"></a>
<FONT color="green">113</FONT>            /** Constant for the attribute type.*/<a name="line.113"></a>
<FONT color="green">114</FONT>            private static final String ATTR_TYPE = "CDATA";<a name="line.114"></a>
<FONT color="green">115</FONT>    <a name="line.115"></a>
<FONT color="green">116</FONT>            /**<a name="line.116"></a>
<FONT color="green">117</FONT>             * Visits the specified node after its children have been processed.<a name="line.117"></a>
<FONT color="green">118</FONT>             *<a name="line.118"></a>
<FONT color="green">119</FONT>             * @param node the actual node<a name="line.119"></a>
<FONT color="green">120</FONT>             * @param key the key of this node<a name="line.120"></a>
<FONT color="green">121</FONT>             */<a name="line.121"></a>
<FONT color="green">122</FONT>            @Override<a name="line.122"></a>
<FONT color="green">123</FONT>            public void visitAfterChildren(Node node, ConfigurationKey key)<a name="line.123"></a>
<FONT color="green">124</FONT>            {<a name="line.124"></a>
<FONT color="green">125</FONT>                if (!isAttributeNode(node))<a name="line.125"></a>
<FONT color="green">126</FONT>                {<a name="line.126"></a>
<FONT color="green">127</FONT>                    fireElementEnd(nodeName(node));<a name="line.127"></a>
<FONT color="green">128</FONT>                }<a name="line.128"></a>
<FONT color="green">129</FONT>            }<a name="line.129"></a>
<FONT color="green">130</FONT>    <a name="line.130"></a>
<FONT color="green">131</FONT>            /**<a name="line.131"></a>
<FONT color="green">132</FONT>             * Visits the specified node.<a name="line.132"></a>
<FONT color="green">133</FONT>             *<a name="line.133"></a>
<FONT color="green">134</FONT>             * @param node the actual node<a name="line.134"></a>
<FONT color="green">135</FONT>             * @param key the key of this node<a name="line.135"></a>
<FONT color="green">136</FONT>             */<a name="line.136"></a>
<FONT color="green">137</FONT>            @Override<a name="line.137"></a>
<FONT color="green">138</FONT>            public void visitBeforeChildren(Node node, ConfigurationKey key)<a name="line.138"></a>
<FONT color="green">139</FONT>            {<a name="line.139"></a>
<FONT color="green">140</FONT>                if (!isAttributeNode(node))<a name="line.140"></a>
<FONT color="green">141</FONT>                {<a name="line.141"></a>
<FONT color="green">142</FONT>                    fireElementStart(nodeName(node), fetchAttributes(node));<a name="line.142"></a>
<FONT color="green">143</FONT>    <a name="line.143"></a>
<FONT color="green">144</FONT>                    if (node.getValue() != null)<a name="line.144"></a>
<FONT color="green">145</FONT>                    {<a name="line.145"></a>
<FONT color="green">146</FONT>                        fireCharacters(node.getValue().toString());<a name="line.146"></a>
<FONT color="green">147</FONT>                    }<a name="line.147"></a>
<FONT color="green">148</FONT>                }<a name="line.148"></a>
<FONT color="green">149</FONT>            }<a name="line.149"></a>
<FONT color="green">150</FONT>    <a name="line.150"></a>
<FONT color="green">151</FONT>            /**<a name="line.151"></a>
<FONT color="green">152</FONT>             * Checks if iteration should be terminated. This implementation stops<a name="line.152"></a>
<FONT color="green">153</FONT>             * iteration after an exception has occurred.<a name="line.153"></a>
<FONT color="green">154</FONT>             *<a name="line.154"></a>
<FONT color="green">155</FONT>             * @return a flag if iteration should be stopped<a name="line.155"></a>
<FONT color="green">156</FONT>             */<a name="line.156"></a>
<FONT color="green">157</FONT>            @Override<a name="line.157"></a>
<FONT color="green">158</FONT>            public boolean terminate()<a name="line.158"></a>
<FONT color="green">159</FONT>            {<a name="line.159"></a>
<FONT color="green">160</FONT>                return getException() != null;<a name="line.160"></a>
<FONT color="green">161</FONT>            }<a name="line.161"></a>
<FONT color="green">162</FONT>    <a name="line.162"></a>
<FONT color="green">163</FONT>            /**<a name="line.163"></a>
<FONT color="green">164</FONT>             * Returns an object with all attributes for the specified node.<a name="line.164"></a>
<FONT color="green">165</FONT>             *<a name="line.165"></a>
<FONT color="green">166</FONT>             * @param node the actual node<a name="line.166"></a>
<FONT color="green">167</FONT>             * @return an object with all attributes of this node<a name="line.167"></a>
<FONT color="green">168</FONT>             */<a name="line.168"></a>
<FONT color="green">169</FONT>            protected Attributes fetchAttributes(Node node)<a name="line.169"></a>
<FONT color="green">170</FONT>            {<a name="line.170"></a>
<FONT color="green">171</FONT>                AttributesImpl attrs = new AttributesImpl();<a name="line.171"></a>
<FONT color="green">172</FONT>    <a name="line.172"></a>
<FONT color="green">173</FONT>                for (ConfigurationNode child : node.getAttributes())<a name="line.173"></a>
<FONT color="green">174</FONT>                {<a name="line.174"></a>
<FONT color="green">175</FONT>                    if (child.getValue() != null)<a name="line.175"></a>
<FONT color="green">176</FONT>                    {<a name="line.176"></a>
<FONT color="green">177</FONT>                        String attr = child.getName();<a name="line.177"></a>
<FONT color="green">178</FONT>                        attrs.addAttribute(NS_URI, attr, attr, ATTR_TYPE, child.getValue().toString());<a name="line.178"></a>
<FONT color="green">179</FONT>                    }<a name="line.179"></a>
<FONT color="green">180</FONT>                }<a name="line.180"></a>
<FONT color="green">181</FONT>    <a name="line.181"></a>
<FONT color="green">182</FONT>                return attrs;<a name="line.182"></a>
<FONT color="green">183</FONT>            }<a name="line.183"></a>
<FONT color="green">184</FONT>    <a name="line.184"></a>
<FONT color="green">185</FONT>            /**<a name="line.185"></a>
<FONT color="green">186</FONT>             * Helper method for determining the name of a node. If a node has no<a name="line.186"></a>
<FONT color="green">187</FONT>             * name (which is true for the root node), the specified default name<a name="line.187"></a>
<FONT color="green">188</FONT>             * will be used.<a name="line.188"></a>
<FONT color="green">189</FONT>             *<a name="line.189"></a>
<FONT color="green">190</FONT>             * @param node the node to be checked<a name="line.190"></a>
<FONT color="green">191</FONT>             * @return the name for this node<a name="line.191"></a>
<FONT color="green">192</FONT>             */<a name="line.192"></a>
<FONT color="green">193</FONT>            private String nodeName(Node node)<a name="line.193"></a>
<FONT color="green">194</FONT>            {<a name="line.194"></a>
<FONT color="green">195</FONT>                return (node.getName() == null) ? getRootName() : node.getName();<a name="line.195"></a>
<FONT color="green">196</FONT>            }<a name="line.196"></a>
<FONT color="green">197</FONT>    <a name="line.197"></a>
<FONT color="green">198</FONT>            /**<a name="line.198"></a>
<FONT color="green">199</FONT>             * Checks if the specified node is an attribute node. In the node<a name="line.199"></a>
<FONT color="green">200</FONT>             * hierarchy attributes are stored as normal child nodes, but with<a name="line.200"></a>
<FONT color="green">201</FONT>             * special names.<a name="line.201"></a>
<FONT color="green">202</FONT>             *<a name="line.202"></a>
<FONT color="green">203</FONT>             * @param node the node to be checked<a name="line.203"></a>
<FONT color="green">204</FONT>             * @return a flag if this is an attribute node<a name="line.204"></a>
<FONT color="green">205</FONT>             */<a name="line.205"></a>
<FONT color="green">206</FONT>            private boolean isAttributeNode(Node node)<a name="line.206"></a>
<FONT color="green">207</FONT>            {<a name="line.207"></a>
<FONT color="green">208</FONT>                return node.isAttribute();<a name="line.208"></a>
<FONT color="green">209</FONT>            }<a name="line.209"></a>
<FONT color="green">210</FONT>        }<a name="line.210"></a>
<FONT color="green">211</FONT>    }<a name="line.211"></a>




























































</PRE>
</BODY>
</HTML>
